通过设置结算的条件,将一个或多个 royalty
对象进行汇总,生成 royalty_settlement
对象,其中为每个分润接收方生成 royalty_transaction
对象。
请求参数 | 描述 |
---|---|
payer_app required string | 分润发起方关联的 app 对象的 id 。 |
method required string | 分润方式。目前支持渠道:wx (微信 App)、wx_pub (微信 JSAPI)、wx_lite (微信小程序)、alipay (支付宝)、unionpay (银联)、allinpay (通联)、jdpay (京东)以及 balance (余额)。 |
recipient_app optional string | 分润接收方的 app 对象的 id 。与 source_user 同时填写时,取其交集。 |
source_user optional string | 分润接收方 user 对象的 id 。与 recipient_app 同时填写时,取其交集。 |
source_no optional string | 关联订单对象的 merchant_order_no 。不能和 source_nos 同时使用。 |
source_nos array string | 关联订单对象的 merchant_order_no 列表。最多可填写 200 个元素。不能和 source_no 同时使用。 |
min_amount optional integer | 最小分润金额,单位为分。创建分润结算时,如果分润接收方的结算金额小于该值,则不会生成 royalty_transaction 对象(不会进入结算)。 |
is_preview optional bool | 是否预览结算结果,选择预览不会真实创建 royalty_settlement 对象(无法被查询),也不会更新 royalty 对象的状态,默认值为 false 。 |
created[gt] optional timestamp | 创建时间大于该值,用 Unix 时间戳表示。 |
created[gte] optional timestamp | 创建时间大于或等于该值,用 Unix 时间戳表示。 |
created[lt] optional timestamp | 创建时间小于该值,用 Unix 时间戳表示。 |
created[lte] optional timestamp | 创建时间小于或等于该值,用 Unix 时间戳表示。 |
metadata optional hash | 详见 元数据。 |
返回
返回一个 royalty_settlement
对象,或者返回一个错误,详见 错误。
POST https://api.pingxx.com/v1/royalty_settlements/
待补充
待补充
待补充
待补充
待补充
待补充
待补充
curl https://api.pingxx.com/v1/royalty_settlements \ -H "Content-Type: application/json" \ -u sk_live_vjfr90jj1q985KuPO84iP8KO: \ -d '{ "payer_app":"app_1Gqj58ynP0mHeX1q", "method": "unionpay", "recipient_app": "app_1Gqj58ynP0mHeX1q", "created": { "gt": 1488211200, "lte": 1488297600 } }'
待补充
待补充
待补充
待补充
待补充
待补充
待补充
{ "id": "170302171104000011", "object": "royalty_settlement", "payer_app": "app_1Gqj58ynP0mHeX1q", "amount": 1000, "amount_canceled": 0, "amount_failed": 0, "amount_succeeded": 0, "count": 10, "count_canceled": 0, "count_failed": 0, "count_succeeded": 0, "created": 1488445864, "fee": 0, "livemode": true, "metadata": {}, "method": "unionpay", "operation_url": null, "royalty_transactions": { "object": "list", "has_more": true, "url": "/v1/royalty_transactions", "data": [ { "id": "170302171104000011", "object": "royalty_transaction", "amount": 15, "status": "created", "settle_account": "320217022818142300000901", "source_user": "user_002", "recipient_app": null, "royalty_settlement": "170302171104000011" }, {...}, {...} ] }, "status": "created", "time_finished": null }